SERVICE

Yes

The name of the service in Site.Service format.

SITE.VHS

HISTORY_FILE_SIZE_MAX_GB

No

The size (in GB) of the disk storage file. The maximum history file size can be safely increased after the service is in operation. If it is decreased, data may be lost. If this keyword is commented out, the size defaults to 10 GB. The maximum size of a VHS datastore is 5000 GB (5 TB).

10 GB

SVC_PORT

Yes

The UDP port number for this service. Each service on the computer must have a unique port number. Use the Config File Manager to ensure that all ports for all services on a given server are unique.

6016

REDUNDANT

No

Indicates whether Redundancy is enabled for this service and it is part of a redundant set with other services.

• Set to TRUE to enable Redundancy for this service and indicate that it is in a redundant relationship with another service within the redundancy environment.
• Set to FALSE or commented out to disable Redundancy for this service.

See Redundancy for more configuration details. A redundancy definition for your CygNet environment is configured in the CygNet Redundancy Editor.

The IN_REDUNDANT_SET (Service in redundant set) info item will report whether this service is part of a redundant relationship.

FALSE

MINIMUM_EXPIRE_DAYS

No

The minimum number of days points are stored in the VHS (i.e., minimum retention period). Points also have a retention property (Keep values within last) that specifies the period of time (in number of days) prior to now that CygNet will keep data points in the VHS. If both options are active, the longer of the two retention periods will take precedence.

None

CHANGE_QUEUE_SIZE

No

Sets the size of the service change queue that contains the incremental changes to the data in the source service. This is the number of changes the service will store to answer replication requests before expiring the oldest changes.

The CHANGE_QUEUE_SIZE (Change Update Queue Size) info item will report configured size of the service change queue.

5,000,000

DATASTORE_VERSION

No

Indicates the data storage technology used by the VHS. The options include:

• 1 — Legacy CygNet VHS datastore method (Obsolete)
• 2 — Microsoft Extensible Storage Engine (ESE) method

See Data Storage for DBS-Based Services for more information.

2

ACS

Yes

The Site and Service name of the service’s ACS, in Site.Service format.

SITE.ACS

ELS

Yes

The Site and Service name of the service’s ELS, in Site.Service format.

SITE.ELS

AUD

No

The Site and Service name of the service’s AUD, in Site.Service format.

SITE.AUD

MSS

Yes

The Site and Service name of the MSS service from which commands will be accepted, in Site.Service format.

SITE.MSS

ACS_ID

Yes

The User ID of the service. This keyword is required for performing security events.

VHS

ACS_APPLICATION

Yes

The service’s application name for security.

VHS

CREATE_JOURNALS

No

If set to TRUE, turns the creation of daily journal files on or off.

TRUE

JOURNAL_RETENTION_DAYS

No

Specifies the number of days that journal files will be retained before they are deleted.

7

JOURNAL_FILES_DIR

No

Specifies the directory that closed journal files will be placed in. This path must be on the same physical file system as the VHS data folder (i.e. the VHS must be able to perform a file move to this folder from the VHS data folder, not a file copy).

.\JournalFiles\

QUICK_RECOVERY_ENABLED

No

If set to TRUE, enables Quick Recovery feature.

If set to TRUE, CHECK_OPTIONS cannot be enabled.

TRUE

CHECK_OPTIONS

No

Defines the level of check to perform when running file check upon restart. This keyword is required for the check to occur.

See also FIX_ERRORS and RUN_CHECK.

If enabled, QUICK_RECOVERY_ENABLED cannot be set to TRUE.

MINIMUM

FIX_ERRORS

No

Switch to enable fixing errors found while performing file check.

See also CHECK_OPTIONS and RUN_CHECK.

TRUE

RUN_CHECK

No

Specifies condition under which to run VHS Check before service restart:

• ALWAYS will run the check before any restart.
• IMPROPER_SHUTDOWN will run the check only if the previous shutdown was improper.

See also CHECK_OPTIONS and FIX_ERRORS.

IMPROPER_
SHUTDOWN

REPL_SOURCE

No

Specifies the Domain and Site.Service name for the source service to be replicated. If not specified, replication is disabled. Applies to all services except ARS, FMS, and RSM.

The REPL_SOURCE (Repl Source Service) info item will report the source service name from which the replicated service is requesting changes.

Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

REPL_CHECK_INTERVAL

No

Indicates the interval (in seconds) to check before performing the next replication synchronization. This value determines the replication synchronization frequency.

After performing a sync, a replicating service will subtract the amount of time the sync took from the check interval time to determine how long to wait until the next sync. For example, if the check interval is 60 seconds and the sync takes 40 seconds, the service will only wait 20 seconds before starting the next sync. If the whole sync time exceeds the frequency, then the replicating service will wait for half the sync interval (30 seconds in this case) before starting the next sync.

The REPL_CHECK_INTERVAL (Repl Poll Secs) info item will report the interval that a replicated service will check the source change queue for new updates. If the service is not replicating REPL_CHECK_INTERVAL will respond with an empty string.

60

REPL_DELAY_MAX

No

Indicates the number of seconds a service is allowed to be behind in replication before it is considered to be behind. If this keyword is disabled, the value defaults to double the REPL_CHECK_INTERVAL time. Best practice recommends enabling and setting a meaningful value for REPL_DELAY_MAX for all replicating services. A recommended value would be a longer time interval than you would expect any sync interval to take.

The REPL_DELAY_MAX (Allowed repl delay) info item will report the time elapsed since the service was last fully in sync. Time is calculated as the delta between "now" and the end of the last full sync that has completed. If the time since the last successful sync exceeds the REPL_DELAY_MAX value, and the REPL_INT_VAL_STATE (Int repl val state) info item is currently "Normal", then the REPL_INT_VAL_STATE info item is set to "Delayed." The state can only be set back to "Normal" when the time between two syncs is less than the REPL_DELAY_MAX time.

120

DESTINATION_SERVICE

No

The name of the service to which forwarded data will be sent. The format is [DDDD]Site.Service where DDDD is replaced by the CygNet Domain where the history forwarder service is running.

None

FORWARDING_INTERVAL

No

This keyword can be used to define a "send interval" for forwarding messages. The source VHS compresses data into forward messages. Once the message is full it is sent to the destination VHS. If the message is not full by the specified "send interval" it is sent anyway. When active, the forwarding message will be sent to the destination VHS once the message is full or when the send interval is met, whichever comes first. The interval keyword value must specify an integer and an interval: s=seconds, m=minutes, h=hours, or d=day.

5m

FORWARDING_QUEUE_EXPIRATION

No

The amount of time (in seconds, minutes, hours, or days) a message will be stored in the queue. Once a message exceeds the defined period it will be deleted from the queue. This keyword is used to manage the size of the queue. The queue time keyword value must specify an integer and an interval: s=seconds, m=minutes, h=hours, or d=day.

2d

FORWARDING_MAX_BACKLOG

No

The maximum number of messages the queue is allowed to hold. When a new message is queued and the maximum backlog is exceeded, either the oldest or newest message will be dropped (depends on setting of the keyword FORWARDING_EXPIRE_TYPE). This keyword is used to manage the size of the queue.

2000

FORWARDING_EXPIRE_TYPE

No

Determines which messages to delete (the oldest or newest message) when the queue reaches its maximum backlog.

OLD

FORWARDING_RESPONSE_TIMEOUT

No

The number of seconds the source VHS will wait for a response from the destination VHS for an acknowledgment of receipt before it tries resending a replication response message. The response time keyword value must specify an integer and an interval: s=seconds, m=minutes, h=hours, or d=day.

30s

DESTINATION_2_SERVICE

No

A second Site.Service to send replicated data.

The only required keyword for a second forwarder is DESTINATION_2_SERVICE. All parameters of the first forwarder will apply for the defaults, if the first is not used.

[DDDD]DEST2.VHS

FORWARDING_2_INTERVAL

No

This keyword can be used to define a "send interval" for forwarding messages. The source VHS compresses data into forward messages. Once the message is full it is sent to the destination VHS. If the message is not full by the specified "send interval" it is sent anyway. When active, the forwarding message will be sent to the destination VHS once the message is full or when the send interval is met, whichever comes first. The interval keyword value must specify an integer and an interval: s=seconds, m=minutes, h=hours, or d=day.

5m

FORWARDING_2_QUEUE_EXPIRATION

No

The amount of time (in seconds, minutes, hours, or days) a message will be stored in the queue. Once a message exceeds the defined period it will be deleted from the queue. This keyword is used to manage the size of the queue. The queue time keyword value must specify an integer and an interval: s=seconds, m=minutes, h=hours, or d=day.

2d

FORWARDING_2_MAX_BACKLOG

No

The maximum number of messages the queue is allowed to hold. When a new message is queued and the maximum backlog is exceeded, either the oldest or newest message will be dropped (depends on setting of the keyword FORWARDING_EXPIRE_TYPE). This keyword is used to manage the size of the queue.

2000

FORWARDING_2_EXPIRE_TYPE

No

Determines which messages to delete (the oldest or newest message) when the queue reaches its maximum backlog.

OLD

FORWARDING_2_RESPONSE_TIMEOUT

No

The number of seconds the source VHS will wait for a response from the destination VHS for an acknowledgment of receipt before it tries resending a replication response message. The response time keyword value must specify an integer and an interval: s=seconds, m=minutes, h=hours, or d=day.

30s

DESTINATION_3_SERVICE

No

A third Site.Service to send replicated data.

The only required keyword for a third forwarder is DESTINATION_3_SERVICE. All parameters of the first forwarder will apply for the defaults, if the first is not used.

[DDDD]DEST3.VHS

FORWARDING_3_INTERVAL

No

This keyword can be used to define a "send interval" for forwarding messages. The source VHS compresses data into forward messages. Once the message is full it is sent to the destination VHS. If the message is not full by the specified "send interval" it is sent anyway. When active, the forwarding message will be sent to the destination VHS once the message is full or when the send interval is met, whichever comes first. The interval keyword value must specify an integer and an interval: s=seconds, m=minutes, h=hours, or d=day.

5m

FORWARDING_3_QUEUE_EXPIRATION

No

The amount of time (in seconds, minutes, hours, or days) a message will be stored in the queue. Once a message exceeds the defined period it will be deleted from the queue. This keyword is used to manage the size of the queue. The queue time keyword value must specify an integer and an interval: s=seconds, m=minutes, h=hours, or d=day.

2d

FORWARDING_3_MAX_BACKLOG

No

The maximum number of messages the queue is allowed to hold. When a new message is queued and the maximum backlog is exceeded, either the oldest or newest message will be dropped (depends on setting of the keyword FORWARDING_EXPIRE_TYPE). This keyword is used to manage the size of the queue.

2000

FORWARDING_3_EXPIRE_TYPE

No

Determines which messages to delete (the oldest or newest message) when the queue reaches its maximum backlog.

OLD

FORWARDING_3_RESPONSE_TIMEOUT

No

The number of seconds the source VHS will wait for a response from the destination VHS for an acknowledgment of receipt before it tries resending a replication response message. The response time keyword value must specify an integer and an interval: s=seconds, m=minutes, h=hours, or d=day.

30s

SYSTEM_LOGGING

TRACE_LOGGING

NET_LOGGING

LOGMASK_ELS

Yes

Specifies the types of service events to be logged to the associated ELS (specified in the ELS keyword). To disable logging to the ELS, comment out the ELS keyword for the selected service. See the Note below this table for more information about the keyword values.

See LOGMASK_ELS in the Logging section of this Help for more information.

The LOGMASK_ELS ( LMask ELS) info item will report the value of this keyword.

CONTROL EXCEPTIONS

LOGMASK_FILE

Yes

Specifies the type(s) of service events to be logged to the service’s log file ([file name].log). During the current session of the service, data is written to the current log file. Log file names follow the naming convention of the selected logging mode (as set by the LOGFILE_MODE keyword value). See the Note below this table for more information about the keyword values.

See LOGMASK_FILE in the Logging section of this Help for more information.

The LOGMASK_FILE (LMask File) info item will report the value of this keyword.

CONTROL EXCEPTIONS WARNING

LOGFILE_FILE_COUNT

Yes

Specifies the maximum number of log files that a service will create before it starts re-using log files. For example, a count of two will produce SVC001.log, then SVC002.log, and then start back at SVC001.log, where SVC is the name of the service. Specify any value from 2 to 100.

See LOGFILE_FILE_COUNT in the Logging section of this Help for more information.

The LOGFILE_FILE_COUNT (File Cnt) info item will report the value of this keyword.

2

LOGFILE_LINE_COUNT

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is LINE, this keyword specifies the maximum number of lines per log file. When the specified line count is reached, the log file is truncated at the limit point, and logging is resumed using the next available log file. Specify any value from 1000 to 1000000.

See LOGFILE_LINE_COUNT in the Logging section of this Help for more information.

The LOGFILE_LINE_COUNT (Line Cnt) info item will report the value of this keyword.

100000

LOGFILE_MODE

Yes

Specifies the operational mode for the log file, that is, how log files are maintained. Options are LEGACY or EXTENDED. The default value is LEGACY.

See LOGFILE_MODE in the Logging section of this Help for more information.

The LOGFILE_MODE (Logging Mode) info item will report the value of this keyword.

LEGACY

LOGFILE_LIMIT_MODE

Yes

Specifies how to limit the size of each individual log file. Options are LINE (maximum line count is determined by the LOGFILE_LINE_COUNT keyword) or SIZE (maximum file size in megabytes) determined by the LOGFILE_FILE_SIZE keyword).

The default value is LINE.

See LOGFILE_LIMIT_MODE in the Logging section of this Help for more information.

The LOGFILE_LIMIT_MODE (Limit Mode) info item will report the value of this keyword.

LINE

LOGFILE_FILE_SIZE

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is set to SIZE, this keyword specifies the maximum size (in megabytes) allowed for a log file, before logging will be continued using the next log file. Possible maximum size values are user-determined, respecting the limits of your specific system configuration. The default value is 100 megabytes. When the specified limit is reached, the log finishes the current line, closes the current file, and then continues logging in the next available log file.

See LOGFILE_FILE_SIZE in the Logging section of this Help for more information.

The LOGFILE_FILE_SIZE (File Size) info item will report the value of this keyword.

100 megabytes

BACKUP_PATH

No

Specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

BACKUP_TIME

No

Specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

COPY_BACKUP_TO

No

Enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

AUDIT_LEVEL

No

Sets auditing level of messages written to the AUD service. When set to 0, auditing is off.

1

AUDIT_LEVEL_BLOB

No

Sets the auditing level for adds, deletes, and updates of extended entry BLOBs. Only changes to BLOB lengths are recorded in the AUD service.

1

VHS_FILE_SIZE_GROW_BY_MB

No

As the VHS datastore grows, the VHS will resize the database by this amount in megabytes.

Performance and unused space are the two factors to consider when adjusting this value. There are performance benefits to raising the "grow by size" parameter: filesystem overhead and database file fragmentation are reduced when using a larger "grow by size."

2

VHS_MAX_CACHE_SIZE_MB

No

Specifies the maximum size of the database page cache for the VHS datastore in megabytes. The default for this keyword is 1000 megabytes.

1000

VHS_MIN_CACHE_SIZE_MB

No

Specifies the minimum size of the database page cache for the VHS datastore in megabytes. The default for this parameter is 200 megabytes.

200

VHS_TRANSACTION_LOG_DIR

No

Sets the directory where the transaction log files are stored. You cannot specify the main service directory, but it can be a subdirectory or another location. You can specify a different (faster or smaller) drive, or another location if the txlogs directory is being used for something else.

The DBS_TRANSACTION_LDIR (TxLogs Folder) info item can be used to retrieve the fully qualified path.

Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

.\txlogs\